Skip to content

gh-1815: Clarify when to open issues and pull requests - #1957

Open
picnixz wants to merge 5 commits into
python:mainfrom
picnixz:fixing-issues-triage
Open

picnixz wants to merge 5 commits into
python:mainfrom
picnixz:fixing-issues-triage

Conversation

@picnixz

@picnixz picnixz commented Oct 31, 2026

Copy link
Copy Markdown
Member

First draft of issue/PR choregraphy while staying a bit vague. I used Opus 5.5 for the text and reading the existing parts of the devguide and to polish the tone in a more... diplomatic way I would have said.

Once reviews start, I'm going to make the changes manually (likely).

@read-the-docs-community

read-the-docs-community Bot commented Oct 31, 2026 •

Copy link
Copy Markdown

@willingc willingc left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@picnixz I think you have done a nice job adding more clarity for contributors. Thanks!

@picnixz

picnixz commented Nov 1, 2026

Copy link
Copy Markdown
Member Author

Thanks for the feedback. I find the rythme of some parts of the text a bit to LLM-isque but if native speakers think it's fine, I'm going to keep it as is.

@picnixz

picnixz commented Nov 2, 2026

Copy link
Copy Markdown
Member Author

As said before, the text is principally suggested by an AI and later edited:

  • I mentioned pyperf timeit instead of timeit as well as -X importtime. I still want to write a benchmarking guide which will later be linked to that section.
  • I moved some guidelines about typos and NEWS entries where they belong (we didn't really have duplicates but we just had different places saying more or less related things so I merged them)
  • I also moved the "what is a bug" in the issue-tracker page and linked it. It felt wrong to have it in the PR page about "fixing-issues.rst" (which assumes issues to already exist). In the first place, I wanted to avoid the issues being submitted hence the issue-tracker page is a better fit.

@picnixz
picnixz requested review from hugovk and willingc November 2, 2026 13:58
* someone, such as the issue's author, already said they would open one;
* a pull request for the issue already exists.

In the last two cases, if there has been no activity for a while, ask the

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want to say "avoid asking in the issue 'any updates?'" if you're not interested by the feature at all... But I don't know how to say it (which is why I limited myself to the last 2 cases).

For very old issues I think it's better we find them once again if someone submits a newer report or if someone raises the issue again because they encountered the same problem rather than someone wanting to contriubute and randomly picking a very old issue.


.. _fixing-issues-no-pullrequest:

Consider whether a pull request is needed

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "what is an issue" is in the issue-tracker, but that tracker is in the triage page.

I think it makes more sense to have it with the rest of the issues templates but I (and Claude) wasn't able to find a place in getting-started. So I added this section here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants